cURL
curl --request PATCH \
--url https://app.masivo.ai/api/storefront/v1/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "John Smith",
"platforms": [
"<string>"
],
"dob": "2023-11-07T05:31:56Z",
"document_type": "CL_RUT",
"document_number": "<string>",
"country": "Chile",
"phone": "+593 99 123 4567",
"tags": {},
"metadata": {}
}
'import requests
url = "https://app.masivo.ai/api/storefront/v1/customers/{id}"
payload = {
"name": "John Smith",
"platforms": ["<string>"],
"dob": "2023-11-07T05:31:56Z",
"document_type": "CL_RUT",
"document_number": "<string>",
"country": "Chile",
"phone": "+593 99 123 4567",
"tags": {},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'John Smith',
platforms: ['<string>'],
dob: '2023-11-07T05:31:56Z',
document_type: 'CL_RUT',
document_number: '<string>',
country: 'Chile',
phone: '+593 99 123 4567',
tags: {},
metadata: {}
})
};
fetch('https://app.masivo.ai/api/storefront/v1/customers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.masivo.ai/api/storefront/v1/customers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'John Smith',
'platforms' => [
'<string>'
],
'dob' => '2023-11-07T05:31:56Z',
'document_type' => 'CL_RUT',
'document_number' => '<string>',
'country' => 'Chile',
'phone' => '+593 99 123 4567',
'tags' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.masivo.ai/api/storefront/v1/customers/{id}"
payload := strings.NewReader("{\n \"name\": \"John Smith\",\n \"platforms\": [\n \"<string>\"\n ],\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"document_type\": \"CL_RUT\",\n \"document_number\": \"<string>\",\n \"country\": \"Chile\",\n \"phone\": \"+593 99 123 4567\",\n \"tags\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.masivo.ai/api/storefront/v1/customers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Smith\",\n \"platforms\": [\n \"<string>\"\n ],\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"document_type\": \"CL_RUT\",\n \"document_number\": \"<string>\",\n \"country\": \"Chile\",\n \"phone\": \"+593 99 123 4567\",\n \"tags\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.masivo.ai/api/storefront/v1/customers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"John Smith\",\n \"platforms\": [\n \"<string>\"\n ],\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"document_type\": \"CL_RUT\",\n \"document_number\": \"<string>\",\n \"country\": \"Chile\",\n \"phone\": \"+593 99 123 4567\",\n \"tags\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"customer": {
"id": "<string>",
"name": "John Smith",
"email": "jsmith@example.com",
"registration_date": "2023-11-07T05:31:56Z",
"status": "ACTIVE",
"is_anonymous": false,
"gender": "MALE",
"dob": "2023-11-07T05:31:56Z",
"document_type": "CL_RUT",
"document_number": "<string>",
"country": "Chile",
"phone": "+593 99 123 4567",
"phone_verified": false,
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {},
"consent": {
"consent_string": "COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA",
"version": "2.0",
"consent_timestamp": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"purposes": {
"behavioral_campaigns": true,
"coupon_campaigns": true,
"punchcard_campaigns": true,
"email_marketing": true,
"push_notifications": true,
"whatsapp_marketing": true,
"audience_marketing": true,
"inapp_messages": true,
"news_feed": true,
"link_tracking": true
},
"vendors": {
"vendor_123": true,
"vendor_456": false
}
},
"metrics": {},
"metadata": {}
},
"wallet": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
],
"totals": [
{
"total": 127.6,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiration_date": "2023-11-07T05:31:56Z",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "ACTIVE",
"team_ids": [
"<string>"
],
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"platforms": [
"<string>"
],
"labels": [
"<string>"
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
}
}
]
}
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}Customers
Update customer
Update a customer by id. Only some fields can be updated using these API.
PATCH
/
customers
/
{id}
cURL
curl --request PATCH \
--url https://app.masivo.ai/api/storefront/v1/customers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "John Smith",
"platforms": [
"<string>"
],
"dob": "2023-11-07T05:31:56Z",
"document_type": "CL_RUT",
"document_number": "<string>",
"country": "Chile",
"phone": "+593 99 123 4567",
"tags": {},
"metadata": {}
}
'import requests
url = "https://app.masivo.ai/api/storefront/v1/customers/{id}"
payload = {
"name": "John Smith",
"platforms": ["<string>"],
"dob": "2023-11-07T05:31:56Z",
"document_type": "CL_RUT",
"document_number": "<string>",
"country": "Chile",
"phone": "+593 99 123 4567",
"tags": {},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'John Smith',
platforms: ['<string>'],
dob: '2023-11-07T05:31:56Z',
document_type: 'CL_RUT',
document_number: '<string>',
country: 'Chile',
phone: '+593 99 123 4567',
tags: {},
metadata: {}
})
};
fetch('https://app.masivo.ai/api/storefront/v1/customers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.masivo.ai/api/storefront/v1/customers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'John Smith',
'platforms' => [
'<string>'
],
'dob' => '2023-11-07T05:31:56Z',
'document_type' => 'CL_RUT',
'document_number' => '<string>',
'country' => 'Chile',
'phone' => '+593 99 123 4567',
'tags' => [
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.masivo.ai/api/storefront/v1/customers/{id}"
payload := strings.NewReader("{\n \"name\": \"John Smith\",\n \"platforms\": [\n \"<string>\"\n ],\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"document_type\": \"CL_RUT\",\n \"document_number\": \"<string>\",\n \"country\": \"Chile\",\n \"phone\": \"+593 99 123 4567\",\n \"tags\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.masivo.ai/api/storefront/v1/customers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John Smith\",\n \"platforms\": [\n \"<string>\"\n ],\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"document_type\": \"CL_RUT\",\n \"document_number\": \"<string>\",\n \"country\": \"Chile\",\n \"phone\": \"+593 99 123 4567\",\n \"tags\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.masivo.ai/api/storefront/v1/customers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"John Smith\",\n \"platforms\": [\n \"<string>\"\n ],\n \"dob\": \"2023-11-07T05:31:56Z\",\n \"document_type\": \"CL_RUT\",\n \"document_number\": \"<string>\",\n \"country\": \"Chile\",\n \"phone\": \"+593 99 123 4567\",\n \"tags\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"customer": {
"id": "<string>",
"name": "John Smith",
"email": "jsmith@example.com",
"registration_date": "2023-11-07T05:31:56Z",
"status": "ACTIVE",
"is_anonymous": false,
"gender": "MALE",
"dob": "2023-11-07T05:31:56Z",
"document_type": "CL_RUT",
"document_number": "<string>",
"country": "Chile",
"phone": "+593 99 123 4567",
"phone_verified": false,
"tier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tags": {},
"consent": {
"consent_string": "COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA",
"version": "2.0",
"consent_timestamp": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"purposes": {
"behavioral_campaigns": true,
"coupon_campaigns": true,
"punchcard_campaigns": true,
"email_marketing": true,
"push_notifications": true,
"whatsapp_marketing": true,
"audience_marketing": true,
"inapp_messages": true,
"news_feed": true,
"link_tracking": true
},
"vendors": {
"vendor_123": true,
"vendor_456": false
}
},
"metrics": {},
"metadata": {}
},
"wallet": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lines": [
{
"amount": 123,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issued_at": "2023-11-07T05:31:56Z",
"expiration_date": "2023-11-07T05:31:56Z",
"reservation_expires_at": "2023-11-07T05:31:56Z"
}
],
"totals": [
{
"total": 127.6,
"reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiration_date": "2023-11-07T05:31:56Z",
"reward": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"brand_id": "<string>",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "ACTIVE",
"team_ids": [
"<string>"
],
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": {},
"platforms": [
"<string>"
],
"labels": [
"<string>"
],
"stores": [
"<string>"
],
"channels": [
"<string>"
],
"products": [
"<string>"
],
"tiers": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"name": "<string>",
"description": "<string>",
"type": "POINTS",
"conditions": [
[
{
"type": "Order Value",
"operator": "grater than",
"primitive": "string",
"value": 9.95
}
]
],
"attributes": {
"conversion_factor": 0.1
}
}
}
]
}
}
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The customer unique identifier in your system
Body
application/json
The full name of the customer
Example:
"John Smith"
Platforms associated with the customer
The gender of the customer. Can only be updated if not set.
Available options:
MALE, FEMALE The date of birth of the customer. Can only be updated if not set.
The document type of the customer. If provided, document_number is required.
Available options:
AR_DNI, AR_CUIT, AR_CUIL, AR_PASSPORT, AR_DRIVER_LICENSE, AR_OTHER, BO_CI, BO_NIT, BO_PASSPORT, BO_DRIVER_LICENSE, BO_OTHER, BR_RG, BR_CPF, BR_PASSPORT, BR_DRIVER_LICENSE, BR_OTHER, CL_RUN, CL_RUT, CL_PASSPORT, CL_DRIVER_LICENSE, CL_OTHER, CO_CC, CO_RUT, CO_NIT, CO_PASSPORT, CO_DRIVER_LICENSE, CO_OTHER, CR_CI, CR_PASSPORT, CR_DRIVER_LICENSE, CR_OTHER, DO_CI, DO_PASSPORT, DO_DRIVER_LICENSE, DO_OTHER, EC_CC, EC_RUC, EC_PASSPORT, EC_DRIVER_LICENSE, EC_OTHER, SV_DUI, SV_NIT, SV_PASSPORT, SV_DRIVER_LICENSE, SV_OTHER, GT_DPI, GT_PASSPORT, GT_DRIVER_LICENSE, GT_OTHER, HN_CI, HN_RTN, HN_PASSPORT, HN_DRIVER_LICENSE, HN_OTHER, MX_CURP, MX_RFC, MX_INE, MX_PASSPORT, MX_DRIVER_LICENSE, MX_OTHER, NI_CI, NI_PASSPORT, NI_DRIVER_LICENSE, NI_OTHER, PA_CIP, PA_PASSPORT, PA_DRIVER_LICENSE, PA_OTHER, PY_CI, PY_RUC, PY_PASSPORT, PY_DRIVER_LICENSE, PY_OTHER, PE_DNI, PE_RUC, PE_PASSPORT, PE_DRIVER_LICENSE, PE_OTHER, UY_CI, UY_RUT, UY_PASSPORT, UY_DRIVER_LICENSE, UY_OTHER, VE_CI, VE_RIF, VE_PASSPORT, VE_DRIVER_LICENSE, VE_OTHER Example:
"CL_RUT"
The document number of the customer. If provided, document_type is required.
Maximum string length:
50The country of the customer. English name, independent of the document_type prefix.
Available options:
Argentina, Bolivia, Brazil, Chile, Colombia, Costa Rica, Dominican Republic, Ecuador, El Salvador, Guatemala, Honduras, Mexico, Nicaragua, Panama, Paraguay, Peru, Uruguay, Venezuela Example:
"Chile"
The customer's phone number in international format. Required for WhatsApp delivery.
Example:
"+593 99 123 4567"
Include your conditions customer tags here
The metadata of the customer
Response
Customer updated
Show child attributes
Show child attributes